Skip to main content

Start-IMJob

SYNOPSIS​

Starts Immich background jobs

SYNTAX​

Start-IMJob [[-Session] <ImmichSession>] [-Job] <String[]> [-Force] [-ProgressAction <ActionPreference>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Initiates various background processing jobs in Immich such as thumbnail generation, metadata extraction, face detection, and other system maintenance tasks. Jobs run asynchronously in the background.

EXAMPLES​

EXAMPLE 1​

Start-IMJob -Job 'thumbnailGeneration'

Starts thumbnail generation for all assets missing thumbnails.

EXAMPLE 2​

Start-IMJob -Job 'faceDetection' -Force

Forces face detection to run on all applicable assets.

EXAMPLE 3​

Start-IMJob -Job 'duplicateDetection'

Starts duplicate detection analysis across the entire library.

EXAMPLE 4​

@('metadataExtraction', 'thumbnailGeneration') | ForEach-Object { Start-IMJob -Job $_ }

Starts multiple job types sequentially.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Job​

The type of job to start. Valid values include thumbnailGeneration, metadataExtraction, videoConversion, faceDetection, facialRecognition, smartSearch, duplicateDetection, and others.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force​

Forces the job to start even if similar jobs are already running or queued.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

This cmdlet supports ShouldProcess and will prompt for confirmation before starting jobs. Jobs run in the background and progress can be monitored using Get-IMJob.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github